home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1994 November: Tool Chest / Dev.CD Nov 94.toast / Tool Chest / Development Tools & Languages / Macintosh Common Lisp Related / interfaces / PInterface Translator / PInterfaces / Components.p < prev    next >
Encoding:
Text File  |  1993-09-16  |  8.1 KB  |  239 lines  |  [TEXT/MPS ]
  1. { 
  2.  Created: Tuesday, October 13, 1992
  3.  Components.p
  4.  Pascal Interface to the Macintosh Libraries
  5.  
  6.  Copyright Apple Computer, Inc. 1991, 1992
  7.  All rights reserved
  8. }
  9.  
  10.  
  11. {$IFC UNDEFINED UsingIncludes}
  12. {$SETC UsingIncludes := 0}
  13. {$ENDC}
  14.  
  15. {$IFC NOT UsingIncludes}
  16.  UNIT Components;
  17.  INTERFACE
  18. {$ENDC}
  19.  
  20. {$IFC UNDEFINED UsingComponents}
  21. {$SETC UsingComponents := 1}
  22.  
  23. {$I+}
  24. {$SETC ComponentsIncludes := UsingIncludes}
  25. {$SETC UsingIncludes := 1}
  26. {$IFC UNDEFINED UsingTypes}
  27. {$I $$Shell(PInterfaces)Types.p}
  28. {$ENDC}
  29. {$IFC UNDEFINED UsingTypes}
  30. {$I $$Shell(PInterfaces)Memory.p}
  31. {$ENDC}
  32. {$SETC UsingIncludes := ComponentsIncludes}
  33.  
  34. CONST
  35. gestaltComponentMgr = 'cpnt';
  36.  
  37. kAnyComponentType =            0;
  38. kAnyComponentSubType =         0;
  39. kAnyComponentManufacturer =    0;
  40. kAnyComponentFlagsMask =    0;
  41.  
  42. cmpWantsRegisterMessage = $80000000;
  43.  
  44.  
  45. TYPE
  46. ComponentDescription = RECORD
  47.  componentType: OSType;                                { A unique 4-byte code indentifying the command set }
  48.  componentSubType: OSType;                            { Particular flavor of this instance }
  49.  componentManufacturer: OSType;                        { Vendor indentification }
  50.  componentFlags: LONGINT;                            { 8 each for Component,Type,SubType,Manuf/revision }
  51.  componentFlagsMask: LONGINT;                        { Mask for specifying which flags to consider in search, zero during registration }
  52.  END;
  53.  
  54. ResourceSpec = RECORD
  55.  resType: OSType;                                    { 4-byte code  }
  56.  resId: INTEGER;                                    {    }
  57.  END;
  58.  
  59. ComponentResourcePtr = ^ComponentResource;
  60. ComponentResourceHandle = ^ComponentResourcePtr;
  61. ComponentResource = RECORD
  62.  cd: ComponentDescription;                            { Registration parameters }
  63.  component: ResourceSpec;                            { resource where Component code is found }
  64.  componentName: ResourceSpec;                        { name string resource }
  65.  componentInfo: ResourceSpec;                        { info string resource }
  66.  componentIcon: ResourceSpec;                        { icon resource }
  67.  END;
  68.  
  69. Component = ^privateComponentRecord;
  70. ComponentInstance = ^privateComponentInstanceRecord;
  71.  
  72. { Structure received by Component:  }
  73. ComponentParameters = PACKED RECORD
  74.  flags: CHAR;                                        { call modifiers: sync/async, deferred, immed, etc }
  75.  paramSize: CHAR;                                    { size in bytes of actual parameters passed to this call }
  76.  what: INTEGER;                                        { routine selector, negative for Component management calls }
  77.  params: ARRAY [0..0] OF LONGINT;                    { actual parameters for the indicated routine }
  78.  END;
  79.  
  80. ComponentResult = LONGINT;
  81.  
  82. ComponentRoutine = ProcPtr;
  83.  
  84. ComponentFunction = ProcPtr;
  85.  
  86.  
  87. {******************************************************
  88. * Required Component routines
  89. ******************************************************}
  90.  
  91. CONST
  92. kComponentOpenSelect = -1;                            { ComponentInstance for this open }
  93. kComponentCloseSelect = -2;                            { ComponentInstance for this close }
  94. kComponentCanDoSelect = -3;                            { selector # being queried }
  95. kComponentVersionSelect = -4;                        { no params }
  96. kComponentRegisterSelect = -5;                        { no params }
  97. kComponentTargetSelect = -6;                        { ComponentInstance for top of call chain }
  98.  
  99. { Set Default Component flags }
  100. defaultComponentIdentical = 0;
  101. defaultComponentAnyFlags = 1;
  102. defaultComponentAnyManufacturer = 2;
  103. defaultComponentAnySubType = 4;
  104. defaultComponentAnyFlagsAnyManufacturer = defaultComponentAnyFlags+defaultComponentAnyManufacturer;
  105. defaultComponentAnyFlagsAnyManufacturerAnySubType = defaultComponentAnyFlags+defaultComponentAnyManufacturer+defaultComponentAnySubType;
  106.  
  107. { errors from component manager & components }
  108. invalidComponentID = -3000;
  109. validInstancesExist = -3001;
  110. componentNotCaptured = -3002;
  111. componentDontRegister = -3003;
  112.  
  113. badComponentInstance = $80008001;
  114. badComponentSelector = $80008002;
  115.  
  116.  
  117. { *******************************************************
  118. *                                                     *
  119. *              APPLICATION LEVEL CALLS                *
  120. *                                                     *
  121. *******************************************************
  122. * Component Database Add, Delete, and Query Routines 
  123. *******************************************************
  124.  }
  125. FUNCTION RegisterComponent(cd: ComponentDescription;componentEntryPoint: ComponentRoutine;
  126.  global: INTEGER;componentName: Handle;componentInfo: Handle;componentIcon: Handle): Component;
  127.  INLINE $7001,$A82A;
  128. FUNCTION RegisterComponentResource(tr: ComponentResourceHandle;global: INTEGER): Component;
  129.  INLINE $7012,$A82A;
  130. FUNCTION UnregisterComponent(aComponent: Component): OSErr;
  131.  INLINE $7002,$A82A;
  132.  
  133. FUNCTION FindNextComponent(aComponent: Component;looking: ComponentDescription): Component;
  134.  INLINE $7004,$A82A;
  135. FUNCTION CountComponents(looking: ComponentDescription): LONGINT;
  136.  INLINE $7003,$A82A;
  137.  
  138. FUNCTION GetComponentInfo(aComponent: Component;cd: ComponentDescription;
  139.  componentName: Handle;componentInfo: Handle;componentIcon: Handle): OSErr;
  140.  INLINE $7005,$A82A;
  141. FUNCTION GetComponentListModSeed: LONGINT;
  142.  INLINE $7006,$A82A;
  143.  
  144.  
  145. { *******************************************************
  146. * Component Instance Allocation and dispatch routines 
  147. *******************************************************
  148.  }
  149. FUNCTION OpenComponent(aComponent: Component): ComponentInstance;
  150.  INLINE $7007,$A82A;
  151. FUNCTION CloseComponent(aComponentInstance: ComponentInstance): OSErr;
  152.  INLINE $7008,$A82A;
  153.  
  154. FUNCTION GetComponentInstanceError(aComponentInstance: ComponentInstance): OSErr;
  155.  INLINE $700A,$A82A;
  156.  
  157.  
  158. {  direct calls to the Components  }
  159. FUNCTION ComponentFunctionImplemented(ci: ComponentInstance;ftnNumber: INTEGER): LONGINT;
  160.  INLINE $2F3C,$2,$FFFD,$7000,$A82A;
  161. FUNCTION GetComponentVersion(ci: ComponentInstance): LONGINT;
  162.  INLINE $2F3C,$0,$FFFC,$7000,$A82A;
  163. FUNCTION ComponentSetTarget(ci:ComponentInstance; target:ComponentInstance):LONGINT;
  164.  INLINE $2F3C,$4,$FFFA,$7000,$A82A;
  165.  
  166.  
  167. {****************************************************
  168. *                                                    *
  169. *               CALLS MADE BY Components             *
  170. *                                                    *
  171. ******************************************************}
  172.  
  173.  
  174. { *******************************************************
  175. * Component Management routines
  176. *******************************************************
  177.  }
  178. PROCEDURE SetComponentInstanceError(aComponentInstance: ComponentInstance;
  179.  theError: OSErr);
  180.  INLINE $700B,$A82A;
  181.  
  182. FUNCTION GetComponentRefcon(aComponent: Component): LONGINT;
  183.  INLINE $7010,$A82A;
  184. PROCEDURE SetComponentRefcon(aComponent: Component;theRefcon: LONGINT);
  185.  INLINE $7011,$A82A;
  186.  
  187. FUNCTION OpenComponentResFile(aComponent: Component): INTEGER;
  188.  INLINE $7015,$A82A;
  189. FUNCTION CloseComponentResFile(refnum: INTEGER): OSErr;
  190.  INLINE $7018,$A82A;
  191.  
  192.  
  193. { *******************************************************
  194. * Component Instance Management routines
  195. *******************************************************
  196.  }
  197. FUNCTION GetComponentInstanceStorage(aComponentInstance: ComponentInstance): Handle;
  198.  INLINE $700C,$A82A;
  199. PROCEDURE SetComponentInstanceStorage(aComponentInstance: ComponentInstance;
  200.  theStorage: Handle);
  201.  INLINE $700D,$A82A;
  202.  
  203. FUNCTION GetComponentInstanceA5(aComponentInstance: ComponentInstance): LONGINT;
  204.  INLINE $700E,$A82A;
  205. PROCEDURE SetComponentInstanceA5(aComponentInstance: ComponentInstance;
  206.  theA5: LONGINT);
  207.  INLINE $700F,$A82A;
  208.  
  209. FUNCTION CountComponentInstances(aComponent: Component): LONGINT;
  210.  INLINE $7013,$A82A;
  211.  
  212. {  useful helper routines for convenient method dispatching  }
  213. FUNCTION CallComponentFunction(params: ComponentParameters;func: ComponentFunction): LONGINT;
  214.  INLINE $70FF,$A82A;
  215. FUNCTION CallComponentFunctionWithStorage(storage: Handle;params: ComponentParameters;
  216.  func: ComponentFunction): LONGINT;
  217.  INLINE $70FF,$A82A;
  218. FUNCTION DelegateComponentCall(originalParams: ComponentParameters;
  219.  ci: ComponentInstance): LONGINT;
  220.  INLINE $7024,$A82A;
  221.  
  222. FUNCTION SetDefaultComponent(aComponent: Component;flags: INTEGER): OSErr;
  223.  INLINE $701E,$A82A;
  224. FUNCTION  OpenDefaultComponent(componentType: OSType; componentSubType: OSType ) : ComponentInstance;
  225.  INLINE $7021,$A82A;
  226. FUNCTION CaptureComponent(capturedComponent: Component;capturingComponent: Component): Component;
  227.  INLINE $701C,$A82A;
  228. FUNCTION UncaptureComponent(aComponent: Component): OSErr;
  229.  INLINE $701D,$A82A;
  230. FUNCTION RegisterComponentResourceFile(resRefNum:INTEGER;global:INTEGER):LONGINT;
  231.  INLINE $7014,$A82A;
  232.  
  233. {$ENDC} { UsingComponents }
  234.  
  235. {$IFC NOT UsingIncludes}
  236.  END.
  237. {$ENDC}
  238.  
  239.